GET States?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves states for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
None. |
| take |
Number of states to retrieve. Default is all states |
integer |
None. |
| skip |
Number of states to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the states before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of states.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of State |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"StateId": "dcc98e93-14a0-4e5b-8b20-1acdb3669de9",
"Asset": {
"AssetId": "ca56f2c7-4be0-49c9-ad2b-323c10c936e8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "405789ae-728d-4d0b-97ba-678cbaa88d85",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e9a2fc39-9bcd-4268-ad41-21390896f844",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5a8fa443-c318-4588-953c-056bb7aee6ca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3d337dfc-72d3-4dcf-9b26-504cbfc21770",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "c5ec425f-ddfa-4016-b282-a5719d2e9b2d",
"EffectiveDate": "2024-04-28T16:51:51.7907342-07:00",
"StatusType": {
"StatusTypeId": "a3bc44dd-64e0-4840-90fc-597bd791b0cf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "405789ae-728d-4d0b-97ba-678cbaa88d85",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e9a2fc39-9bcd-4268-ad41-21390896f844",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d945acad-2bb3-498d-a7f5-da55ca0aa955",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3f6a6c41-daa6-4935-a504-6e15ef272194",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0a17e98e-f0f6-4045-9242-2e2580a569ed",
"EffectiveDate": "2024-04-28T16:51:51.7907342-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "21fbe918-4a45-48ac-8ebb-7ddff6b313a7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "57a81d1f-57c0-4b6f-b65f-a4465471a8fa",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "145245d3-c666-4c48-ba6d-d0e89cbb5565",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "778648f2-6630-404d-ba5d-c19ca2c2ebbe",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2024-04-28T16:51:51.7907342-07:00",
"StateType": {
"StateTypeId": "b494db03-5761-450e-86e4-a040aec62368",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "405789ae-728d-4d0b-97ba-678cbaa88d85",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e9a2fc39-9bcd-4268-ad41-21390896f844",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6c9c74a0-6263-4ef5-85d0-5400cfcb8594",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "10e41f5c-59b5-4387-be17-c8c5513969d9",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 4"
},
{
"StateId": "dcc98e93-14a0-4e5b-8b20-1acdb3669de9",
"Asset": {
"AssetId": "ca56f2c7-4be0-49c9-ad2b-323c10c936e8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "405789ae-728d-4d0b-97ba-678cbaa88d85",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e9a2fc39-9bcd-4268-ad41-21390896f844",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5a8fa443-c318-4588-953c-056bb7aee6ca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3d337dfc-72d3-4dcf-9b26-504cbfc21770",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "c5ec425f-ddfa-4016-b282-a5719d2e9b2d",
"EffectiveDate": "2024-04-28T16:51:51.7907342-07:00",
"StatusType": {
"StatusTypeId": "a3bc44dd-64e0-4840-90fc-597bd791b0cf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "405789ae-728d-4d0b-97ba-678cbaa88d85",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e9a2fc39-9bcd-4268-ad41-21390896f844",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d945acad-2bb3-498d-a7f5-da55ca0aa955",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3f6a6c41-daa6-4935-a504-6e15ef272194",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0a17e98e-f0f6-4045-9242-2e2580a569ed",
"EffectiveDate": "2024-04-28T16:51:51.7907342-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "21fbe918-4a45-48ac-8ebb-7ddff6b313a7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "57a81d1f-57c0-4b6f-b65f-a4465471a8fa",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "145245d3-c666-4c48-ba6d-d0e89cbb5565",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:51:51.7907342-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "778648f2-6630-404d-ba5d-c19ca2c2ebbe",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2024-04-28T16:51:51.7907342-07:00",
"StateType": {
"StateTypeId": "b494db03-5761-450e-86e4-a040aec62368",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "405789ae-728d-4d0b-97ba-678cbaa88d85",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e9a2fc39-9bcd-4268-ad41-21390896f844",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6c9c74a0-6263-4ef5-85d0-5400cfcb8594",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "10e41f5c-59b5-4387-be17-c8c5513969d9",
"CreateDate": "2024-04-28T16:51:51.7907342-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:51:51.7907342-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}